2023 iThome 鐵人賽

DAY 3

自我挑戰組

ROS2 及 ROS Porting 自學筆記系列第 4 篇

Day4 ROS2 Package - C++

15th鐵人賽 ros2 ros catkin colcon

leochien1110

2023-09-17 02:33:58

1284 瀏覽

分享至

哇!本來以為發文了，結果只有案到存成草稿，睡到一半想到嚇醒，果然第一屆鐵人GG了，虧我還準備了5天的份以備不時之需...
我還是會盡力補完30天的QQ

ROS2中Package比較大的改動就是C++和Python無法在混用。應該是原則上沒辦法，但爬文還是可以找到workaround，大意上就是利用CMakeLists.txt去Compile Python，不過不是正統的方式這邊就不多說明。

C++

使用Colcon 創建C++ ROS2 Package：

ros2 pkg create --build-type ament_cmake <package_name>

如同昨天Workspace提到，C++的Package應該會長的類似這樣：

cpp_package_1/
  CMakeLists.txt
  include/cpp_package_1/
  package.xml
  src/

include及src是用來存放程式主要source及header file的地方。

CMakeLists.txt就跟一般C++一樣，不過裡面多了ament的一些ROS2相關的Macro，可以更方便的找到路徑底下的ROS2 Packages和安裝binary到目標位置，方便管理。

package.xml 則是列出了所以ros dependencies的相依和執行層級，必須同時出現在cpp_package內。

CMakeLists.txt

在ROS時代，用的是catkin，而在ROS2時代，則是用ament，兩者的差異如下：

catkin

找到catkin的package，並且找到roscpp、rospy、std_msgs的相依。這個步驟目的是找到相對應的ROS header和library:

find_package(catkin REQUIRED COMPONENTS
roscpp
rospy
std_msgs
)

# Non-ROS
find_package(PCL REQUIRED)
find_package(Eigen3 REQUIRED)
find_package(OpenCV REQUIRED)

接著用catkin_package的Macro來描述這個package的相依和執行層級，用來建構、生成package config和CMake的訊息：
```
catkin_package(
  CATKIN_DEPENDS roscpp rospy std_msgs
  INCLUDE_DIRS include
  LIBRARIES cpp_package_1
  DEPENDS system_lib
)
```
- CATKIN_DEPENDS：列出這個package的相依，這邊是roscpp、rospy、std_msgs。
- INCLUDE_DIRS：列出這個package的include路徑，也就是src內的header file，目的是給其他的package使用，這邊是include。
- LIBRARIES：列出這個package的library，這邊是cpp_package_1，可以讓其他的package使用。
- DEPENDS：列出非ROS的相依，這邊是system_lib。
接著是include_directories，這邊是用來指定include的路徑給compiler，若有非ROS的library，也都要在這邊指定路徑給compiler：
```
include_directories(
    include
    ${catkin_INCLUDE_DIRS}
    ${PCL_INCLUDE_DIRS}
    ${Eigen3_INCLUDE_DIRS}
    ${OpenCV_INCLUDE_DIRS}
)
```
首先要先指定include的路徑，這邊是include，然後是ROS的library，這邊是${catkin_INCLUDE_DIRS}，最後隨便舉了幾個常用的非ROS的libraries。

link_directories則是用來指定library的路徑給compiler，一般不建議使用，因為find_package會自動幫你找到library的路徑。
add_executable，這邊是用來指定執行檔的名稱及source code的路徑：
```
add_executable(${PROJECT_NAME}_node src/cpp_package_1_node.cpp)
```
如果有要build非可執行檔的library(沒有main function)以及pluginlib，則是用add_library：
```
add_library(helper src/cpp_without_main.cpp)
```

最後是target_link_libraries，這邊是用來連接library和執行檔：

target_link_libraries(${PROJECT_NAME}_node
  ${catkin_LIBRARIES} 
  ${PCL_LIBRARIES}
  ${OpenCV_LIBRARIES}
  ${Eigen3_LIBRARIES}
  helper
)

這邊的helper是上面add_library的library。

幾本上這樣可執行檔就可以建好在build/，如果要安裝到install/，則是在CMakeLists.txt內用install：

install(TARGETS ${PROJECT_NAME}_node
  RUNTIME DESTINATION ${CATKIN_PACKAGE_BIN_DESTINATION}
  LIBRARY DESTINATION ${CATKIN_PACKAGE_LIB_DESTINATION}
)

這邊的CATKIN_PACKAGE_BIN_DESTINATION以及CATKIN_PACKAGE_LIB_DESTINATION是catkin的Macro，會自動幫你找到bin和library的路徑。

可以連同launch, plugins, config等等一起安裝：

install(DIRECTORY launch
  DESTINATION ${CATKIN_PACKAGE_SHARE_DESTINATION}/launch
    FILES_MATCHING PATTERN "*.launch"
)
install(DIRECTORY config
  DESTINATION ${CATKIN_PACKAGE_SHARE_DESTINATION}/config
  FILES_MATCHING PATTERN "*.yaml" PATTERN "*.cfg"
)
install(DIRECTORY plugins
  DESTINATION ${CATKIN_PACKAGE_SHARE_DESTINATION}/plugins
  FILES_MATCHING PATTERN "*.xml"
)

其實還有其他的類型的Macro，像是add_service_files、add_action_files、add_message_files、add_dependencies等等，不過這些都是用來描述ROS的相關訊息，所以會在package.xml內描述，這邊就不多說明。

Message
Service
Action
Dynamic Reconfigure

ament

找到ament的package，並且找到rclcpp、std_msgs的相依。這個步驟目的是找到相對應的ROS header和library:
```
# ROS
find_package(ament_cmake REQUIRED)
find_package(rclcpp REQUIRED)
find_package(std_msgs REQUIRED)

# Non-ROS
find_package(PCL REQUIRED)
find_package(Eigen3 REQUIRED)
find_package(OpenCV REQUIRED)
```
:warning: 注意：ament_cmake是ament的一個package，所以要先找到ament_cmake才能找到其他的package。

另外在ROS2, python一般來說是獨立成一個package，所以不會出現在ament_cmake的find_package內。
不過如果有需要，也可以用find_package(ament_cmake_python REQUIRED)來找到python的package。
include_directory是用來指定include的路徑給compiler：
```
include_directories(
    include
    ${PCL_INCLUDE_DIRS}
    ${Eigen3_INCLUDE_DIRS}
    ${OpenCV_INCLUDE_DIRS})
```
可以明顯的看到，ament的include_directory沒有ROS的library，因為ament會自動幫你找到ROS的library。

然而且ament也不會幫你找到非ROS的library，所以要自己指定路徑給compiler。
接著是add_executable，用來指定執行檔的名稱及source code的路徑：
```
add_executable(${PROJECT_NAME}_node src/cpp_package_1_node.cpp)
```
如果有要build非可執行檔的library(沒有main function)，則是用add_library：
```
add_library(helper src/cpp_without_main.cpp)
```
plugin在ROS2有做更動，從原本幾乎都在package.xml內描述，改成在CMakeLists.txt內描述。這邊先列出plugin的cmake寫法，之後會再詳細說明：
```
pluginlib_export_plugin_description_file(cpp_package_1 plugin.xml)
```

target_link_libraries用來連接非ROS的library和執行檔：

target_link_libraries(${PROJECT_NAME}_node
    helper
    ${PCL_LIBRARIES}
    ${OpenCV_LIBRARIES}
    ${Eigen3_LIBRARIES}
)

最後ROS2的改動，ament_target_dependencies，用來連接ROS2的library和執行檔：
```
ament_target_dependencies(${PROJECT_NAME}_node
    rclcpp
    std_msgs
)
```
install的Macro則是在ros2 pkg create --build-type ament_cmake <package_name>時自動產生：
```
install(
 TARGETS ${PROJECT_NAME}_node
 DESTINATION lib/${PROJECT_NAME}
)
```
最後是ament_package用來安裝package.xml、將package註冊到ament index的系統中，以及安裝CMake config已便其他的package可以找到：
```
ament_package()
```
這個指令負責做最後的配置，所以應該放在CMakeLists.txt的最後面。
這邊補充一個官方沒有提到symlink的安裝ament_cmake_symlink_install_files:
```
ament_cmake_symlink_install_files(FILES
    launch
    config
    DESTINATION share/${PROJECT_NAME})
```
這個指令可以將launch和config等資料夾建立symlink到share/${PROJECT_NAME}，這樣就可以在執行檔的路徑下找到launch和config的資料夾，更新launch參數時也不需要重新build。

PCL補充

全名Point Cloud Library，是一個開源的3D點雲處理函式庫，他的CMakeLists.txt比較龜毛，所以要特別注意。find_package後，一定還要宣告下列三行才能正常使用：

find_package(PCL REQUIRED)

include_directories(${PCL_INCLUDE_DIRS})
link_directories(${PCL_LIBRARY_DIRS})
add_definitions(${PCL_DEFINITIONS})

package.xml

package.xml是C++和Python都會用到的描述檔，用來描述這個package的相依。
C++和Python的package.xml差異不大，這邊就直接用C++的package.xml來說明。

C++

<buildtool_depend>ament_cmake</buildtool_depend>
<depend>rclcpp</depend>
<depend>std_msgs</depend>
...
<export>
    <build_type>ament_cmake</build_type>
</export>

buildtool_depend：這邊是用來描述這個package的build tool，這邊是ament_cmake。
depend：這邊是用來描述這個package的ROS相依，這邊是rclcpp、std_msgs。
export：這邊是用來描述這個package的build type，這邊是ament_cmake。

Python

<exec_depend>rclpy</exec_depend>
<exec_depend>std_msgs</exec_depend>
...
<export>
    <build_type>ament_python</build_type>
</export>

沒錯，Python的package.xml只有export和exec_depend，buildtool_depend則是因為Python會靠setup.py和setup.cfg而不再需要。

發現有點講太細了，把Python Package的部分獨立出來，明天再來說明。

Reference

Day3 ROS2 Workspace

Day5 ROS2 Package - Python

系列文

ROS2 及 ROS Porting 自學筆記共 30 篇

RSS系列文訂閱系列文

2 人訂閱

完整目錄

直播研討會

{{ item.channelVendor }} {{ item.webinarstarted }} |

直播中

尚未有邦友留言

立即登入留言

參賽組數

1064 組

團體組數

40 組

累計文章數

22053 篇

完賽人數

594 人

15th鐵人賽 16th鐵人賽 13th鐵人賽 14th鐵人賽 12th鐵人賽 11th鐵人賽鐵人賽 2019鐵人賽 javascript 2018鐵人賽 python 2017鐵人賽 windows php c# windows server linux css react vue.js

IT邦幫忙

ROS2 及 ROS Porting 自學筆記系列 第 4 篇